home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tex / macros / source / contrib / supported / xypic / src / xypoly.doc / node1_mn.html < prev    next >
Text File  |  1995-03-15  |  8KB  |  278 lines
  1.  
  2. <H4><A ID="SECTION00000010000000000000">
  3. Header:</A>
  4. </H4>
  5.  
  6.  
  7. <P>
  8. Some of the effects use || so make sure the `arrow' feature is loaded.
  9. (
  10. <#8#>arrow<#8#>
  11.  
  12.  
  13. )
  14.  
  15. <P>
  16. 3 
  17. (
  18.  
  19. )
  20.  
  21. <P>
  22. 3 
  23.  
  24. <P><BR>
  25.  
  26. <P>
  27. A polygon is most easily specified using ...
  28. <BR>
  29. <tex2html_image_mark>#defs11#
  30. <BR>
  31.  
  32. Here ;SPMlt;number;SPMgt; is a sequence of digits, giving the number of sides.
  33. If used within an ||...|| environment then the polygon 
  34. will be centred on <I>c</I>, the current ;SPMlt;pos;SPMgt;. However an ||
  35. can be used outside such an environment, as ``stand-alone'' polygon;
  36. the whole picture must be specified within the || command.  
  37.  
  38. <P>
  39. In either case the shape is obtained by spacing vertices equally 
  40. around the ``unit circle'' with respect to the current basis. 
  41. If this basis is non-square then the vertices will lie on an ellipse.
  42. Normally the polygon, with at most 12 vertices, is oriented so as to
  43. have a flat base when specified using a standard square basis. 
  44. With more than 12~vertices the orientation is such that the line
  45. from the centre to the first vertex is horizontal, pointing to the right.
  46. Any other desired orientation can be obtained, with any number of vertices,
  47. by using the |~=<#16#>|...|<#16#>| as described below.
  48.  
  49. <P>
  50.  
  51. <P><BR>
  52. The general form for || is ...
  53. <BR>
  54. <tex2html_image_mark>#defs117#
  55. <BR>
  56. where the |;SPMquot;|;SPMlt;prefix;SPMgt;|;SPMquot;| and ;SPMlt;switches;SPMgt; are optional.
  57. Their uses will be described shortly.
  58.  
  59. <P>
  60.  
  61. <P><BR>
  62.  
  63. <P>
  64. A || establishes positions for the vertices of a polygon.
  65. At the same time various things may be typeset, 
  66. according to the  specified ;SPMlt;switches;SPMgt;.
  67. An ;SPMlt;object;SPMgt; may be dropped at each vertex, ``spokes'' drawn to the
  68. centre and successive vertices may be connected as the polygon's ``sides''.
  69. Labels and breaks can be specified along the spokes and sides.
  70.  
  71. <P>
  72. Each vertex is automatically named: 
  73. |;SPMquot;1;SPMquot;|, |;SPMquot;2;SPMquot;|, ..., |;SPMquot;|;SPMlt;number;SPMgt;|;SPMquot;| with |;SPMquot;0;SPMquot;| as centre.
  74. When a ;SPMlt;prefix;SPMgt; has been given, 
  75. names |;SPMquot;|;SPMlt;prefix;SPMgt;|0;SPMquot;|, ..., |;SPMquot;|;SPMlt;prefix;SPMgt;;SPMlt;number;SPMgt;|;SPMquot;| are used instead.
  76. While the polygon is being constructed the macro || expands to 
  77. the number of sides, while || expands to the number
  78. of each vertex, spoke and side at the time it is processed. 
  79. This occurs in the following order: 
  80. <#20#><I>vertex</I><#20#> 1, <#21#><I>spoke</I><#21#> 1, <#22#><I>vertex</I><#22#> 2, 
  81. <#23#><I>spoke</I><#23#> 2, <#24#><I>side</I><#24#> 1, <#25#><I>vertex</I><#25#> 3, 
  82. <#26#><I>spoke</I><#26#> 3, <#27#><I>side</I><#27#> 2, ..., <#28#><I>vertex</I><#28#> <I>n</I>, 
  83. <#29#><I>spoke</I><#29#> <I>n</I>, <#30#><I>side</I><#30#> <I>n</I> - 1, <#31#><I>side</I><#31#> <I>n</I>
  84. where the final side joins the last vertex to the first.
  85.  
  86. <P>
  87. The macro || holds the name of the polygon, 
  88. which is ;SPMlt;prefix;SPMgt; if supplied. In this case the value of 
  89. || is also stored as |||;SPMlt;prefix;SPMgt;|NUMSIDES|, 
  90. accessible outside the polygon.
  91.  
  92. <P>
  93. As stated above, a polygon with up to 12 vertices is oriented 
  94. so as to have a flat base, when drawn using a standard square basis. 
  95. Its vertices are numbered in anti-clockwise order, commencing with the one 
  96. at horizontal-right of centre, or the smallest angle above this
  97. (see example below). 
  98. With more than 12 vertices then vertex |;SPMquot;1;SPMquot;| is located on the horizontal, 
  99. extending to the right from centre (assuming a standard square basis).
  100. By providing a switch of the form |~=<#32#>|;SPMlt;angle;SPMgt;|<#32#>| then the vertex |;SPMquot;1;SPMquot;|
  101. will be located on the unit circle at ;SPMlt;angle;SPMgt;<SUP><TT>o</TT></SUP> anti-clockwise
  102. from ``horizontal'' --- more correctly, from the <I>X</I>-direction in the
  103. basis to be used when setting the polygon, which may be established
  104. using a  |~:<#33#>|...|<#33#>| switch.
  105.  
  106. <P>
  107. <BR>
  108. <tex2html_image_mark>#code34#
  109. <BR>
  110. <P><tex2html_verbatim_mark>#math363#</P><DIV ALIGN="CENTER">
  111. <tex2html_image_mark>#tex2html_wrap_indisplay1241#
  112. </DIV><P></P>
  113. <BR>
  114. <tex2html_image_mark>#exercise46#
  115. <BR>
  116.  
  117.  
  118. <P>
  119. One important use of ;SPMlt;prefix;SPMgt; is to allow the vertices of more than one 
  120. polygon to be accessed subsequently within the same picture. 
  121. Here are some examples of this, 
  122. incorporating the |~:<#49#>|...|<#49#>| switch to perform simple rescalings.
  123. Firstly the edges of a dodecahedron as a planar graph:
  124.  
  125. <P>
  126. <BR>
  127. <tex2html_image_mark>#code50#
  128. <BR>
  129. <P><tex2html_verbatim_mark>#math364#</P><DIV ALIGN="CENTER">
  130. <tex2html_image_mark>#tex2html_wrap_indisplay1243#
  131. </DIV><P></P>
  132.  
  133.  
  134. <P>
  135.  
  136. Next a hexagonal pyramid, a rectangular box
  137. and an octahedral crystal specified as a triangular anti-prism. 
  138. Notice how the |~:<#68#>|...|<#68#>| switch is used to create non-square bases, 
  139. allowing the illusion of 3D-perspective in the resulting diagrams:
  140.  
  141. <P>
  142. <BR>
  143. <tex2html_image_mark>#code69#
  144. <BR>
  145. <P><tex2html_verbatim_mark>#math365#</P><DIV ALIGN="CENTER">
  146. <tex2html_image_mark>#tex2html_wrap_indisplay1245#
  147. </DIV><P></P>
  148.  
  149.  
  150. <P>
  151. 2 
  152. || simply reads the value of a counter called |@|.
  153. It is set initially at -1, to indicate no polygon yet. This is used to
  154. establish the default naming in case polygons are nested.
  155.  
  156. <P>
  157. (
  158. @<#82#>count<#82#>@@=@ne
  159. @<#83#>@<#83#>
  160.  
  161. <P>
  162. @@ <#84#><#84#>
  163. @<#85#>@ <#85#>
  164. )
  165.  
  166. <P>
  167. To allow recursion the values of |@ | and |@| are saved
  168. upon entering an ||, to be restored at the end.
  169.  
  170. <P>
  171. (
  172. @<#86#>@<#86#><tex2html_comment_mark>34
  173.  
  174. <P>
  175. @@<#823#><tex2html_comment_mark>35
  176. @ 
  177.   @ 
  178.    
  179.    @<#806#>@@<#769#>@<#651#>@=@ne<#651#><#769#><#806#><tex2html_comment_mark>38
  180.  
  181.  
  182.   @ 
  183.    
  184.    @<#808#>@@<#771#>@<#653#>@=@ne <#653#><#771#><#808#><tex2html_comment_mark>41
  185.  
  186.  
  187.  @ @=@ @@n<#823#>
  188.  
  189. <P>
  190. @@ <#93#>TF<#93#><tex2html_comment_mark>42
  191. @@x<#654#>@@<#94#>@@<#94#><#654#>
  192. )
  193.  
  194. <P>
  195. Read the number of vertices by parsing digits.
  196.  
  197. <P>
  198. (
  199. @@n<#655#><tex2html_comment_mark>43
  200. @##1<#95#>@10@##1@@n<#95#><tex2html_comment_mark>44
  201.  @
  202.   @;SPMgt;@ @ @<#96#>@@i<#96#><tex2html_comment_mark>45
  203. @ @<#97#>@@n<#97#>
  204.  0123
  205.  4567
  206.  89
  207.  @ =@i @ <#655#>
  208.  
  209. <P>
  210. @@i<#656#>@@<#656#>
  211. )
  212.  
  213. <P>
  214. Next we check whether a prefix has been supplied for creating the vertex
  215. names. If so it is stored as |@|, which otherwise expands to
  216. empty. The number of sides is also stored using the prefix.
  217.  
  218. <P>
  219. (
  220. @@<#99#><#99#><tex2html_comment_mark>46
  221. @@@ <#100#><#100#><tex2html_comment_mark>47
  222. @<#101#>@<#101#><tex2html_comment_mark>48
  223.  
  224. <P>
  225. @@<#772#><tex2html_comment_mark>49
  226. ;SPMquot;@;SPMquot;##1;SPMquot;<#657#>
  227.   @@ <#657#><tex2html_comment_mark>51
  228.  
  229.   @;SPMlt;@
  230.    @<#106#>@@<#106#><tex2html_comment_mark>54
  231. @ <#772#>
  232.  
  233. <P>
  234. @@@<#809#><tex2html_comment_mark>55
  235. @<#107#>@;SPMquot;<#107#><tex2html_comment_mark>56
  236. @<#108#>@@ 0;SPMquot;<#108#><tex2html_comment_mark>57
  237. @ 
  238.  @;SPMlt;@
  239.   @@<#773#>@<#658#>@=@
  240.    <#658#>@=@ <#773#><tex2html_comment_mark>59
  241.  
  242.   @@<#774#>@<#659#>@=@
  243.    <#659#>@=@ <#774#><tex2html_comment_mark>60
  244. @@i <#809#>
  245. )
  246.  
  247. <P>
  248. Currently any tokens remaining before the opening brace are
  249. discarded, with an accompanying message.
  250.  
  251. <P>
  252. (
  253. @@@i#1#<#660#>
  254.  @<#113#>#1<#113#>@ 
  255.  @<#114#>discarding unused tokens: #1<#114#>@@ <#660#>
  256. )
  257.  
  258. <P>
  259. Next it is time to analyse the braced information,
  260. e.g. to set switches and/or adjust the scale.
  261. If this information is empty |<#115#><#115#>| then the default
  262. values are used.
  263.  
  264. <P>
  265. (
  266. @@@#1<#661#>@
  267.  @<#116#>#1<#116#>@ @<#117#>@@@<#117#><tex2html_comment_mark>62
  268. @<#118#>@@#1~!<#118#>@ <#661#>
  269.  
  270. <P>
  271. @@<#775#>@ 
  272.  @ 
  273.  <#775#>
  274. )
  275.  
  276. <P>
  277. 3 
  278.